home *** CD-ROM | disk | FTP | other *** search
/ Megadoom II / MEGADOOM II - iso.7z / MEGADOOM II.ISO / doom / editors / map / dmpsmu / dmpsmu.man < prev    next >
Text File  |  1994-10-31  |  15KB  |  392 lines
  1.  
  2. DMPSMU(1)                                               DMPSMU(1)
  3.  
  4. NAME
  5.      dmpsmu - DooM PostScript Maps Utility
  6.  
  7. SYNOPSIS
  8.      dmpsmu  [ -? ] [ -w main WAD file ] [ -pw patch WAD file ] [
  9.      -file patch WAD files ...  ]
  10.  
  11. AVAILABILITY
  12.      This command has been tested only on SunOS4.1,  IRIX4.0  and
  13.      Linux1.0.9,  but  it should be easily portable to other Unix
  14.      flavors and to PC/DJGPP.
  15.  
  16. DESCRIPTION
  17.      dmpsmu is an interactive utility of which the primary  func-
  18.      tion  is  to  generate PostScript maps of levels in DOOM and
  19.      DOOM ][, the 3D action games by id Software.  It is  derived
  20.      from DEU, the Doom Editor Utility and retains from this tool
  21.      all functions that have a read-only effect on the  DOOM  WAD
  22.      files,  thus  allowing  examination  but not modification of
  23.      these files under Unix.
  24.  
  25.      The appearance of the PostScript maps  is  controlled  by  a
  26.      large number of print flags, yielding a wide range of possi-
  27.      bilities in outputting the maps. Besides printing the  basic
  28.      map, dmpsmu offers several advanced features:
  29.      - detailed control over layout and appearance of the page(s)
  30.      - multi-page capability, printing on 2 or 4 normal pages
  31.      - detailed control over which Things will be printed
  32.      - fading LineDefs that are secret or part of a secret Sector
  33.      - shading secret Sector areas, but not their inner Sectors
  34.      - linking teleporters and their exits by faint lines
  35.      For  an explanation of Things, LineDefs and Sectors, as well
  36.      as anything else you may want to know about WAD  files,  see
  37.      the DOOM Specs.
  38.  
  39. OPTIONS
  40.      Options   are   case-insensitive  and  filenames  are  case-
  41.      sensitive.  Both the short and long forms of the options are
  42.      listed.
  43.  
  44.      -? -h -help
  45.           Displays usage information.
  46.  
  47.      -w -main
  48.           Specifies  the  name  of  the main WAD file; default is
  49.           DOOM.WAD.  Eg. to use  the  shareware  main  WAD  file,
  50.           specify: -w DOOM1.WAD .
  51.  
  52.      -pw -pwad
  53.           Specifies the name of a patch WAD file.  Eg. to merge a
  54.           single patch WAD file, specify: -pw <file>.WAD .
  55.  
  56.      -file
  57.           Specifies a list of names of patch WAD files.   Eg.  to
  58.  
  59. DMPSMU                   31 October 1994                        1
  60.  
  61. DMPSMU(1)                                               DMPSMU(1)
  62.  
  63.           merge   several   patch   WAD   files,  specify:  -file
  64.           <file1>.WAD <file2>.WAD <file3>.WAD .
  65.  
  66. COMMANDS
  67.      Commands,  print  flags  and  directory  entries  are  case-
  68.      insensitive   and   filenames  and  level  names  are  case-
  69.      sensitive.  Both the short and long forms  of  the  commands
  70.      are listed.
  71.  
  72.      ? H Help
  73.           Gives  a brief command overview. The commands and their
  74.           parameters with a short explanation are displayed.
  75.  
  76.      A Analyze
  77.           Analyzes and displays a level's statistics. Specify  an
  78.           episode  number  and a mission number for a DOOM level,
  79.           or 0 (zero) and a map number for a DOOM  ][  level.  An
  80.           overview  of  that  map's characteristics is displayed:
  81.           the map dimensions, the amount of structures of various
  82.           kinds   (including  the  number  of  player-teleporting
  83.           LineDefs and secret Sectors), a  break-down  of  Things
  84.           into  classes (see THING CLASSES below) and break-downs
  85.           of PowerUps (weapons and enhancements) and Enemies into
  86.           types.  The Analyze command respects the state of the M
  87.           and U print flags.
  88.  
  89.      D Dump
  90.           Displays a directory entry in hex. Specify the name  of
  91.           a  directory  entry  and an optional output filename. A
  92.           hex/text dump of the entry is displayed, pausing  after
  93.           every 23 lines, or written to the file. In case of mul-
  94.           tiple entries with the same name,  the  command  allows
  95.           for skipping to the next such entry, or writes all such
  96.           entries to the file.
  97.  
  98.      F Flags
  99.           Displays or sets the print flags. If no parameters  are
  100.           specified,  the  current  state of all flags is listed.
  101.           Otherwise, specify a  list  of  flag  settings  to  set
  102.           (+flag)  or  reset  (-flag)  any  print flag. See PRINT
  103.           FLAGS below for the available flags and their  meaning.
  104.  
  105.      L List
  106.           Lists  the directory of a WAD file. Specify the name of
  107.           a (main or patch) WAD file and an optional output file-
  108.           name. The directory of the WAD file is displayed, paus-
  109.           ing after every 23 lines, or written to the file.
  110.  
  111.      M Master
  112.           Displays the master directory.  Optionally  specify  an
  113.           output  filename.   The  master directory is displayed,
  114.           pausing after every 23 lines, or written to  the  file.
  115.           The  master  directory is an administrative list, main-
  116.           tained by the program, of the  directory  entries  from
  117.  
  118. DMPSMU                   31 October 1994                        2
  119.  
  120. DMPSMU(1)                                               DMPSMU(1)
  121.  
  122.           all  open  files, both the main WAD file and any merged
  123.           patch WAD files.
  124.  
  125.      N Name
  126.           Displays or (re)sets the user level name. If no parame-
  127.           ter is specified, the current name is displayed. Other-
  128.           wise, specify the name to  be  used  when  subsequently
  129.           printing  or  analyzing a level, or '' to reset it. The
  130.           main purpose is to temporarily set the actual name of a
  131.           patch WAD level before printing, overruling the regular
  132.           name for that episode/mission.
  133.  
  134.      P Print
  135.           Prints the map of a level to a PostScript file. Specify
  136.           an  episode  number  and  a  mission  number for a DOOM
  137.           level, or 0 (zero) and a  map  number  for  a  DOOM  ][
  138.           level.  Follow  either combination with an output file-
  139.           name. The layout and objects of that map are printed in
  140.           PostScript  to the file, according to the currect print
  141.           flag settings.
  142.  
  143.      Q Quit
  144.           Quits the program.
  145.  
  146.      R Read
  147.           Reads a new patch WAD file. Specify the filename  of  a
  148.           patch  WAD  file.   The  file is read and its directory
  149.           entries are merged into the master directory, overwrit-
  150.           ing any duplicate entries.
  151.  
  152.      W Wads
  153.           Displays  a  list  of  the  open WAD files. Requires no
  154.           parameters.  The currently open WAD files  are  listed,
  155.           starting  with  the  main  WAD file and then any merged
  156.           patch WAD files.
  157.  
  158.      X Xtract Extract
  159.           Extracts a directory entry into a raw file. Specify the
  160.           name  of  a directory entry and an output filename. The
  161.           entry is written as binary data to the file.   In  case
  162.           of  multiple entries with the same name, only the first
  163.           such entry is extracted.
  164.  
  165. THING CLASSES
  166.      As shown by the Analyze command, Things are grouped  in  the
  167.      following classes:
  168.  
  169.      START     player and deathmatch starting points
  170.  
  171.      TLPORT    teleport exits
  172.  
  173.      BONUS     helmets,  potions,  stimpacks,  medikits and small
  174.                ammunition
  175.  
  176. DMPSMU                   31 October 1994                        3
  177.  
  178. DMPSMU(1)                                               DMPSMU(1)
  179.  
  180.      WEAPON    weapons and boxes of ammunition
  181.  
  182.      ENHANC    keys, armours,  spheres,  hi-tech  gadgets  (suit,
  183.                goggles, etc.) and backpacks
  184.  
  185.      ENEMY     former humans, imps, demons, barons, etc.
  186.  
  187.      DECOR     pillars, torches, stakes, dead monsters, etc.
  188.  
  189.      BARREL    explosive barrels
  190.  
  191. PRINT FLAGS
  192.      The  following  flags  are available with the Flags command,
  193.      shown in their 'set' meaning with their 'reset'  meaning  in
  194.      brackets:
  195.  
  196.      2   use double [normal] page
  197.          Double  pages  are  A3  or Tabloid, depending on flag A.
  198.          The resulting PostScript file can be displayed  using  a
  199.          GhostScript viewer.  To print the file into an upper and
  200.          lower normal sized page,  use  the  dmps2ul.sh  command.
  201.          Flags 2 and 4 cannot both be set; if necessary flag 4 is
  202.          reset.
  203.  
  204.      4   use quadruple [normal] page
  205.          Quadruple pages are A2 or double_Tabloid,  depending  on
  206.          flag  A.  The resulting PostScript file can be displayed
  207.          using a GhostScript viewer, although not all viewers may
  208.          be  able to show the whole map.  To print a normal sized
  209.          page from the file for each of the 4 quadrants, use  the
  210.          dmps4qd.sh command. Flags 2 and 4 cannot both be set; if
  211.          necessary flag 2 is reset.
  212.  
  213.      A   use A4 [Letter] paper size
  214.          Gives a choice of European and American paper sizes.
  215.  
  216.      B   print [no] border around map
  217.          The border is  a  solid  rectangle  with  a  thin  white
  218.          stripe, 0.25 inch inside the edges of the paper.
  219.  
  220.      D   print all [no] decorations & barrels
  221.          Decorations  are  printed as tiny crosses and barrels as
  222.          small circles.
  223.  
  224.      E   print all [no] enemies
  225.          Enemies are printed as triangles with a  line  extending
  226.          from the center in the direction the monster faces.
  227.  
  228.      F   [don't] fade secret lines
  229.          Prints  faint lines for LineDefs part of a secret Sector
  230.          and for secret LineDefs.
  231.  
  232.      G   print all [no] goodies (weapons/bonuses/enhancements)
  233.          Weapons are printed as double squares, bonuses as  small
  234.  
  235. DMPSMU                   31 October 1994                        4
  236.  
  237. DMPSMU(1)                                               DMPSMU(1)
  238.  
  239.          single squares and enhancements as double circles.
  240.  
  241.      L   print [no] legend above map
  242.          The legend is a box in the upper-right corner of the map
  243.          with the icons used for the Thing classes  and  the  map
  244.          scale.   This  is a relative scale, indicating the ratio
  245.          of map coordinates to PostScript coordinates.  Note that
  246.          without the border (flag B), the legend box looks incom-
  247.          plete.
  248.  
  249.      M   print [no] multi-player things
  250.          Multi-player Things also include player 2,  3  &  4  and
  251.          deathmatch starting points.
  252.  
  253.      N   print [no] name above map
  254.          The  name is a text in the upper-left corner of the map,
  255.          printed as ExMy: <map name> . In  the  name,  x  is  the
  256.          episode  number,  y is the mission number and <map name>
  257.          is the user level name if set or else the regular  name.
  258.  
  259.      P   use Portrait [Landscape] orientation
  260.          Offers  a choice of horizontal and vertical map orienta-
  261.          tion, allowing auto-zoom to achieve  the  optimum  scale
  262.          depending on a map's dimensions.
  263.  
  264.      S   [don't] shade secret areas
  265.          Prints faint areas for secret Sectors; any inner Sectors
  266.          (eg. massive pillars) are not shaded.
  267.  
  268.      T   [don't] link teleports
  269.          Prints a faint line from the middle of each (incl.  mon-
  270.          ster-only)  teleporting  LineDef  to  the  corresponding
  271.          teleport exit.
  272.  
  273.      U   print things for [below] Ultra-Violence skill
  274.          Things below UV skill are all Things on the first  three
  275.          difficulty  levels  together.  This is a simplification,
  276.          but nobody plays below UV anyway, right? :-)
  277.  
  278.      Z   auto-zoom [default] map scale
  279.          Auto-zoom computes the scale such that the map  achieves
  280.          an  optimum  fit  on  the page, depending on paper size,
  281.          orientation and the presence of name and/or legend.  The
  282.          default scale ensures that the largest level (E3M6) fits
  283.          on a normal Portrait page; this helps to get an idea  of
  284.          the sizes of the maps relative to eachother.
  285.  
  286.      By  default, all flags except 2, 4 and M are set. The player
  287.      1 starting point and  teleport  exits  are  always  printed.
  288.      Starting points are printed as circles and teleport exits as
  289.      squares.  Both have a line extending from the center in  the
  290.      direction the player faces at that point.
  291.  
  292. DMPSMU                   31 October 1994                        5
  293.  
  294. DMPSMU(1)                                               DMPSMU(1)
  295.  
  296. EXAMPLES
  297.      The command:
  298.  
  299.        dmpsmu -pw foobar.wad
  300.  
  301.      starts the utility with the following messages:
  302.  
  303.        DMPSMU: DooM PostScript Maps Utility, ver 2.0
  304.         By Frans P. de Vries (fpv@xymph.iaf.nl)
  305.        [Derived from DEU v5.21 GCC by Brendon Wyber and Raphael Quinet]
  306.  
  307.        Patch WAD file: foobar.wad.
  308.        Loading main WAD file: DOOM.WAD...
  309.        Loading patch WAD file: foobar.wad...
  310.           [Updating level E1M1]
  311.  
  312.      Some examples of dmpsmu commands are shown below:
  313.  
  314.        [? for help]> flags -p +m
  315.  
  316.        -P      use Landscape orientation
  317.        +M      print multi-player things
  318.  
  319.        [? for help]> n FooBar
  320.  
  321.        User level name set : FooBar
  322.  
  323.        [? for help]> print 1 1 foobar.ps
  324.  
  325.        Outputting PostScript map of level E1M1 to "foobar.ps".
  326.  
  327.        [? for help]> name ''
  328.  
  329.        User level name reset
  330.  
  331.        [? for help]> a 3 6
  332.  
  333.        Statistics of level E3M6: Mt. Erebus
  334.        ========================
  335.  
  336.        MapDim:   MaxX    MinX   SizeX    MaxY    MinY   SizeY
  337.                  4216   -2568    6784    3392   -3400    6792
  338.  
  339.        Struct: Things  Vertxs  LinDfs  TelePt  SidDfs  Sectrs  Secret
  340.                   334     550     687      10     949     125       4
  341.  
  342.        Things:  START  TLPORT   BONUS  WEAPON  ENHANC   ENEMY   DECOR  BARREL
  343.                     9       6      60      18      16     126      85       0
  344.  
  345.        PowrUps:SHOTGN  COMBAT  CHAING  RCKTLR  PLASMA   BFG9K  CHNSAW  BERSRK  BCKPCK
  346.                     1       0       1       1       1       0       1       1       1
  347.                GRNARM  BLUARM  SOULSP  MEGASP  BLURAF  INVLAF  RDSUIT  CMPMAP  LITAMP
  348.                     2       1       2       0       0       2       5       1       0
  349.  
  350. DMPSMU                   31 October 1994                        6
  351.  
  352. DMPSMU(1)                                               DMPSMU(1)
  353.  
  354.        Enemies: HUMAN   SARGE  COMNDO     IMP   DEMON  SPECTR  LOSTSL  CACODM  PNELEM
  355.                     7      18       0      36       6       4      32      22       0
  356.                MANCBS  REVENT  KNIGHT   BARON  ARCHNO  ARVILE  CYBERD  SPIDER  WOLFSS
  357.                     0       0       0       1       0       0       0       0       0
  358.  
  359. SEE ALSO
  360.      DEU  5.21,  by  Raphael Quinet (quinet@montefiore.ulg.ac.be)
  361.      and Brendon J. Wyber (b.wyber@csc.canterbury.ac.nz),  ported
  362.      to  GCC  by  Per Allansson (c91peral@und.ida.liu.se) and Per
  363.      Kofod (per@ollie.dnk.hp.com)
  364.  
  365.      DOOM Specs v1.666, by Matt  Fell  (matt.burnett@acebbs.com),
  366.      distributed by Hank Leukart (ap641@cleveland.freenet.edu)
  367.  
  368.      dmpsmap(1)
  369.  
  370. LIMITATIONS
  371.      When  shading  secret  Sectors,  those  with  more  than 100
  372.      LineDefs are skipped.
  373.  
  374. DIAGNOSTICS
  375.      dmpsmu can show warning messages in the following format:
  376.           [<warning message>.]
  377.      or terminate with error messages in the following format:
  378.           Program Error: *** <error message> ***
  379.      The messages are fairly self-explanatory and  are  therefore
  380.      not repeated here.
  381.  
  382. NOTES
  383.      The  T print flag really just emerged out of my inability to
  384.      remember which teleporter took me to which part of  the  end
  385.      area in E3M7 :-)
  386.  
  387. AUTHOR
  388.      Frans P. de Vries (fpv@xymph.iaf.nl)
  389.  
  390. DMPSMU                   31 October 1994                        7
  391.  
  392.